Edits to improve functionality and documentation #889
Conversation
added check for file being FISPACT instead of FISPACT-II for program user's convenience
added a line that encouraged users to be appropriate on the forum
| @@ -224,3 +224,5 @@ it is as easy as forking the repository on GitHub, making your changes, and | |||
| issuing a pull request. If you have any questions about this process don't | |||
| hesitate to ask the mailing list (https://groups.google.com/forum/#!forum/pyne-dev, | |||
| pyne-dev@googlegroups.com). | |||
|
|
|||
| Make sure to be appropriate on the forum and provide as clear of an explanation (with examples if possible) of any problems or questions you might have. | |||
There was a problem hiding this comment.
We should probably add a code of conduct for pyne, but until then, "appropriate" is vague. So, perhaps the appropriate wording here is just "Please provide as clear of an explanation (with examples if possible) of any problems or questions you might have."
| @@ -23,3 +23,4 @@ and IPython (v1.0+). Note that only `yt-3.0 <https://bitbucket.org/yt_analysis/y | |||
| supports PyNE. Be sure to use this version of yt rather | |||
| than the more stable v2.x series. | |||
|
|
|||
| """I suggest adding a reference for people to contact incase they have questions here: _________""" | |||
There was a problem hiding this comment.
Rather than have then contact people individually, I'd actually suggest that they submit a ticket in the issues system or send an email to pyne-dev. Perhaps the text you have above would be appropriate here:
If you have any questions about this process, don't hesitate to ask the mailing list (https://groups.google.com/forum/#!forum/pyne-dev, pyne-dev@googlegroups.com). pyne-dev@googlegroups.com). Please provide as clear of an explanation (with examples if possible) of any problems or questions you might have.
| if v == "FISPACT-II": | ||
| """boolean check if file is fispact-ii output (or fispact output for the program user's convinience)""" | ||
| v = check_fisp_version(data) | ||
| if v == "FISPACT": |
There was a problem hiding this comment.
A test is needed to check this case. Can you add a test that demonstrates the FISPACT (rather than FISPACT-II) behavior here?
| """boolean check if file is fispact-ii output (or fispact output for the program user's convinience)""" | ||
| v = check_fisp_version(data) | ||
| if v == "FISPACT": | ||
| print("File is FISPACT instead of FISPACT-II") |
There was a problem hiding this comment.
Rather than print, an exception or a warning is more appropriate here. Either raise an exception or execute a warning message with "warn" and return something (true or false) in this if v=FISPACT block.
|
Hi @Luisg55 . Thanks for your contribution! I made a few suggestions for changes that will be necessary before I can approve his request. |
| """boolean check if file is fispact-ii output """ | ||
| v = check_fisp_version(data) | ||
| if v == "FISPACT-II": | ||
| """boolean check if file is fispact-ii output (or fispact output for the program user's convinience)""" |
There was a problem hiding this comment.
convinience → convenience. As you change this comment, you can fix "fispact-ii" into "FISPACT-II".
• I tried to improve documentation by contributing to the initial README and the tutorial README
• I tried improving functionality of the fispact.py, specifically the isFisII() function